# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: 'Default Metal: Hellsinger Template'

game: 'Metal: Hellsinger'
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.

'Metal: Hellsinger':
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ################
  # Goal Options #
  ################
  win_condition:
    # Hells Completion - To complete the game, slay the required amount of Aspects
    # Sheol Completion - To complete the game, require the completion of the Hell 'Sheol'
    hells_completion: 0
    sheol_completion: 50

  required_hells_completion:
    # If Hells completions are required, select the number of slain Aspects that are required for completion.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 8
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-8: 0 # random value between 1 and 8

  require_no_tomorrow_for_sheol:
    # If enabled with randomized songs, requires the boss song 'No Tomorrow' to access 'Sheol'
    'false': 50
    'true': 0

  require_coat_of_arms_for_sheol:
    # If enabled, requires a certain amount of Coat of Arms to access 'Sheol'
    # 
    # If no other option randomizes Coat of Arms, adds each Coat of Arms as a location that grant a Coat of Arms for each non-Sheol Hell (28),
    # as well as 4 randomized ones (those from Sheol) into the item pool.
    'false': 50
    'true': 0

  required_coat_of_arms_for_sheol:
    # The required amount of Coat of Arms to access 'Sheol'
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 32
    26: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-32: 0 # random value between 1 and 32

  ##############################
  # Hells and Torments Options #
  ##############################
  randomized_hells_enabled:
    # Includes the Hells as unlockables, otherwise all hells are accessable from the start.
    'false': 0
    'true': 50

  hells_unlocks_as_progressive:
    # When Hells are included as unlockables, changes these to be progressive instead of individual unlocks.
    # 
    # The order of Hells is: Voke - Stygia - Yhelm - Incaustis - Gehenna - Nihil - Acheron - Sheol
    # Tutorial is its own item.
    'false': 50
    'true': 0

  starting_hells:
    # If Hells are randomized as individual unlocks, select your starting Hell.
    voke: 50
    stygia: 0
    yhelm: 0
    incaustis: 0
    gehenna: 0
    nihil: 0
    acheron: 0

  require_aspect_for_boss_arena:
    # If enabled, adds the Aspects as unlockables to the item pool.
    # 
    # Without the Aspect of a Hell, the boss arena can't be entered.
    # Hells with Aspects: Voke - Stygia - Yhelm - Incaustis - Gehenna - Nihil - Acheron
    'false': 50
    'true': 0

  regressive_difficulty:
    # If enabled, starts the game in the highest difficulty and can be lowered by collecting regressive difficulty items.
    # 
    # Warning: This IS difficult, especially with some randomized abilities.
    'false': 50
    'true': 0

  starting_difficulty:
    # The individual difficulties are their own items.
    # Pick your starting difficulty.
    # 
    # - Lamb = Easy
    # - Goat = Medium
    # - Beast = Hard
    # - Archdevil = Very Hard
    lamb: 0
    goat: 50
    beast: 0
    archdevil: 0

  randomized_torments_enabled:
    # Includes the Torments as unlockables.
    'false': 0
    'true': 50

  torment_unlocks_as_progressive:
    # When Torments are included as unlockables, change these to be progressive instead of individual unlocks.
    # 
    # Each Torment progresses on its own, with progressive 'Killing with Rhythm', 'Weapon Trickery' as items.
    'false': 50
    'true': 0

  require_stage_for_torments:
    # If enabled, unlocks Torments only when their respective Hell is unlocked.
    # I.e. to play 'Killing with Rhythm: 1', 'Voke' is also required to start KwR1
    'false': 50
    'true': 0

  require_weapons_for_torments:
    # If enabled, unlocks Torments only when their weapons are unlocked.
    # I.e. to play 'Killing with Rhythm: 1', 'Paz' and 'Persephone' are also required to start KwR1
    # Note: For Ultimate Mastery, this includes weapon ultimates
    'false': 50
    'true': 0

  ############################
  # Randomized Items Options #
  ############################
  starting_weapon:
    # The Randomizer always starts with just one weapon.
    # 
    # If the weapon is not included, a fallback weapon from the available ones is chosen.
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    persephone: 50
    the_hounds: 0
    vulcan: 0
    hellcrow: 0
    the_red_right_hand: 0
    telos: 0
    lost_persephone: 0
    manifested_persephone: 0
    the_lost_hounds: 0
    lost_vulcan: 0

  include_dream_of_the_beast_weapon:
    # If enabled, adds the Red Right Hand to the item pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_purgatory_weapon:
    # If enabled, adds the Telos to the item pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_additional_weapon_variants:
    # If enabled, adds the 'Lost' and 'Manifested' weapons from the Leviathan Mode to the item pool.
    # 
    # Important: Adjust your Randomizer Configuration to access these alternate versions!
    'false': 50
    'true': 0

  randomized_outfits_enabled:
    # If enabled, adds the outfits as items to the pool.
    'false': 50
    'true': 0

  starting_outfit:
    # If randomized outfits are enabled, pick your starting outfit.
    # 
    # If the outfit is not included, a fallback outfit from the available ones is chosen.
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    the_unknown: 50
    the_leviathan: 0
    the_dark_devotee: 0
    the_morning_star: 0
    the_angel_eyes: 0
    the_obsidian: 0
    the_amethyst: 0
    the_chromatica: 0

  include_dream_of_the_beast_outfits:
    # If enabled, add all 3 DLC outfits as items to the pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_purgatory_outfits:
    # If enabled, add all 3 DLC outfits as items to the pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  randomized_songs_enabled:
    # If enabled, adds the game's songs as items to the pool.
    'false': 50
    'true': 0

  starting_main_song:
    # If randomized songs are enabled, pick your starting main song.
    this_is_the_end: 50
    stygia: 0
    burial_at_night: 0
    this_devastation: 0
    poetry_of_cinder: 0
    dissolution: 0
    acheron: 0
    silent_no_more: 0

  starting_boss_song:
    # If randomized songs are enabled, pick your starting boss song.
    blood_and_law: 50
    infernal_invocation_i_hopes_and_fears: 0
    infernal_invocation_ii_defiance: 0
    infernal_invocation_iii_dreaming_in_distortion: 0
    no_tomorrow: 0

  include_dusk_soundtrack_songs:
    # If enabled, adds all 9 Dusk Soundtrack songs as items to the pool.
    'false': 50
    'true': 0

  include_dream_of_the_beast_songs:
    # If enabled, adds both Dream of the Beast songs as items to the pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_purgatory_songs:
    # If enabled, adds all 3 Purgatory songs as items to the pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_essential_hits_soundtrack_songs:
    # If enabled, adds all 8 Essential Hits songs as items to the pool.
    # 
    # Note: The randomizer expects you to own the DLC yourself and won't grant them on its own.
    'false': 50
    'true': 0

  include_progressive_anguish_gate_skips:
    # If enabled, includes items that allow to skip already completed encounters.
    # 
    # 'Encounter Skips For Completions' places these items at the finishing point of encounters.
    # 'Randomized Progressive Encounter Skips' adds the skips as progressive items into the item pool.
    # 'Randomized Individual Encounter Skips' adds the skips as individual items into the item pool, i.e. 'Voke Anguish Gate 1 Skip' instead of 'Progressive Voke Anguish Gate'.
    no_encounter_skips: 50
    encounter_skips_for_completions: 0
    randomized_progressive_encounter_skips: 0
    randomized_individual_encounter_skips: 0

  randomized_slaughter_enabled:
    # If enabled, adds the ability to Slaughter as an item to the pool.
    # 
    # Note: Slaughter Mastery Torments won't be doable until Slaughter is unlocked.
    # Note: The randomizer includes "soft logic" as to requiring certain abilities to access certain parts of hells.
    # Warning: Randomizing too many abilities may lead to very restrictive and difficult starting scenarios.
    'false': 50
    'true': 0

  randomized_dash_enabled:
    # If enabled, adds the ability to Dash and Soar as progressive items to the pool.
    # 
    # Note: The randomizer includes "soft logic" as to requiring certain abilities to access certain parts of hells.
    # Warning: Randomizing too many abilities may lead to very restrictive and difficult starting scenarios.
    'false': 50
    'true': 0

  randomized_jump_enabled:
    # If enabled, adds the ability to Jump and Double Jump as progressive items to the pool.
    # 
    # Note: The randomizer includes "soft logic" as to requiring certain abilities to access certain parts of hells.
    # Warning: Randomizing too many abilities may lead to very restrictive and difficult starting scenarios.
    'false': 50
    'true': 0

  randomized_reload_enabled:
    # If enabled, adds the ability to Quick and Manual Reload as progressive items to the pool.
    # 
    # Note: The randomizer includes "soft logic" as to requiring certain abilities to access certain parts of hells.
    # Warning: Randomizing too many abilities may lead to very restrictive and difficult starting scenarios.
    'false': 50
    'true': 0

  randomized_weapon_ultimates_enabled:
    # If enabled, adds the ability to use weapons ultimates as an individual item for each weapon to the pool.
    # 
    # Note: Ultimate Mastery Torments won't be in logic until all of the required weapons can use their ultimates in them.
    'false': 50
    'true': 0

  randomized_boons_enabled:
    # If enabled, adds all 4 Beatstreak Boons as items and locations to the pool.
    'false': 50
    'true': 0

  destructible_as_unlocks:
    # If enabled, adds the abilities to destroy each destructible type as unlocks to the item pool.
    # 
    # Note: This includes the ability to destroy Health Crystals, removing one source of healing
    # Note: The randomizer includes "soft logic" as to requiring certain abilities to access certain parts of hells.
    # Warning: Randomizing too many abilities may lead to very restrictive and difficult starting scenarios.
    'false': 50
    'true': 0

  filler_items_distribution:
    # Controls the relative probability of each filler item being generated.
    Always on Beat: 35
    Compliment: 50
    Death: 1
    Double Time: 20
    Encouragement: 50
    Failure: 50
    Half Time: 20
    Invisible Weapons: 35
    Max Multiplier: 50
    Next Multiplier: 50
    Reset Multiplier: 20
    Trigger Ultimate: 35
    Weapon Trickery: 35

  ####################
  # Location Options #
  ####################
  torment_medaillons_enabled:
    # Includes the individual medals on each Torment as locations.
    'false': 0
    'true': 50

  include_section_clears_with_weapons_checks:
    # If enabled, adds for each randomized weapon a location for clearing a section with them.
    # 
    # A section is either finishing all four encounters AND entering the boss fight, or finishing the boss fight itself.
    # Warning: This may become tedious to do for each available weapon
    'false': 50
    'true': 0

  include_section_clears_with_outfits_checks:
    # If enabled, adds for each randomized outfit a location for clearing a section with them.
    # 
    # A section is either finishing all four encounters AND entering the boss fight, or finishing the boss fight itself.
    # Warning: This may become tedious to do for each available outfit
    'false': 50
    'true': 0

  include_section_clears_with_songs_checks:
    # If enabled, adds for each randomized main and boss song a location for clearing a section with them.
    # 
    # A section is either finishing all four encounters AND entering the boss fight, or finishing the boss fight itself.
    # Warning: This may become tedious to do for each available song
    'false': 50
    'true': 0

  include_randomized_weapon_skins_checks:
    # If enabled, adds the unlockable weapon skins as locations to the pool, including the skins themself as items.
    # 
    # Also adds each Coat of Arms as a location that grant a Coat of Arms if no other options randomize them.
    'false': 50
    'true': 0

  include_secret_multiplier_checks:
    # If enabled, adds the secret Multiplier of each Hells as a location.
    # 
    # Good luck finding them!
    'false': 50
    'true': 0

  include_coat_of_arms_checks:
    # If enabled, adds all Coat of Arms as collectibles into the item pool.
    # Also adds each Coat of Arms as a location.
    'false': 50
    'true': 0

  include_miscellaneous_checks:
    # If enabled, adds various first time actions such as using ultimates, reaching beat streaks, slaughtering and so on.
    # 
    # Synergistic for enabling various ability randomizations.
    'false': 50
    'true': 0

  destructible_locations_enabled:
    # If enabled, adds a location to destroy all destructibles of each type (Ammostash, Health/Chaos Crystal) in each encounter.
    # Note: Each Destructible only needs to be destroyed once. Destruction status is saved between runs.
    'false': 50
    'true': 0

  singular_destructible_locations_enabled:
    # Requires 'Destructible Completionist per Encounter' to be enabled
    # If enabled, adjusts the destructible checks to be per type per encounter, instead of one check for all destructibles per encounter.
    # Note: Each Destructible only needs to be destroyed once. Destruction status is saved between runs.
    'false': 50
    'true': 0

  hells_destructible_locations_enabled:
    # If enabled, adds additional locations to destroy all of each type of destructible in a Hell.
    # Note: Each Destructible only needs to be destroyed once. Destruction status is saved between runs.
    'false': 50
    'true': 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
